/*
 * @(#) $Header$
 *
 * Copyright (C) 2007  Forklabs Daniel Léonard
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

package ca.forklabs.media.jai.opimage;

import java.awt.RenderingHints;
import java.awt.image.RenderedImage;
import java.awt.image.renderable.ContextualRenderedImageFactory;
import java.awt.image.renderable.ParameterBlock;
import javax.media.jai.CollectionImage;
import javax.media.jai.ImageLayout;
import ca.forklabs.media.jai.opimage.AbstractCRIF;
import ca.forklabs.media.jai.operator.MedianCollectionDescriptor;
import ca.forklabs.media.jai.opimage.MedianCollectionOpImage;

/**
 * Class {@code MedianCollectionCRIF} is a
 * {@link ContextualRenderedImageFactory} supporting the
 * <em>MedianCollection</em> operation in the rendered and renderable image
 * layers.
 *
 * @author   <a href="mailto:forklabs at gmail.com?subject=ca.forklabs.media.jai.opimage.MedianCollectionCRIF">Daniel Léonard</a>
 * @version $Revision$
 * @see    MedianCollectionOpImage
 */
public class MedianCollectionCRIF extends AbstractCRIF {

//---------------------------
// Constructor
//---------------------------

   /**
    * Constructor.
    */
   public MedianCollectionCRIF() {
      super(MedianCollectionDescriptor.NAME);
      }


//---------------------------
// Implemented methods from javax.media.jai.CRIFImpl
//---------------------------

   /**
    * Creates a new instance of {@link MedianCollectionOpImage} in the rendered
    * layer.
    * @param   pb   the parameter block containing the collection of images to
    *               be <em>medianed</em>.
    * @param   hints   optional rendering hints.
    */
   @Override
   public RenderedImage create(ParameterBlock pb, RenderingHints hints) {
      CollectionImage sources = (CollectionImage) pb.getSource(0);
      ImageLayout layout = this.getImageLayout(hints);
      RenderedImage image = new MedianCollectionOpImage(sources, hints, layout);
      return image;
      }

   }
